Skip to content

docs(#79): add CLAUDE.md for agent repo context - #80

Open
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/79-add-claude-md
Open

fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/79-add-claude-md

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown

What this PR does / why we need it:

Adds a CLAUDE.md file to the repository root to provide AI agents with repo-specific context. Without this file, every agent interaction starts from zero context — agents do not know the build commands, vendoring conventions, branch strategy, or downstream workflow. This was observed concretely in PRs #77 and #78, where agents succeeded at their tasks but required extra exploration or missed triage acceptance criteria due to lack of context.

The file covers all seven areas identified in the issue:

  1. Project overview (Red Hat downstream Helm rebuild with FIPS compliance)
  2. Build commands (make build, make test, make build-cross)
  3. FIPS build flags on release branches (GOFIPS140, godebug fips140=auto)
  4. Test commands and patterns (go test, testify, golden file generation)
  5. Dependency management (Go modules, vendoring on release branches only)
  6. Branch strategy (main for v4 dev, release-X.Y for Red Hat rebuilds)
  7. Downstream integration (Jira references, OCP targets, upstream_sources.yml, Brew builds)
  8. Review guidance for dependency bumps

The file is 92 lines — concise and focused on what agents need to make good decisions.

Special notes for your reviewer:

Content was verified against the actual Makefile, go.mod, .golangci.yml, CI workflows, and release branch configurations (e.g. release-3.21 Makefile FIPS flags, go.mod godebug directive). No assumptions from the issue body were taken at face value.

If applicable:

  • this PR contains user facing changes (the docs needed label should be applied if so)
  • this PR contains unit tests
  • this PR has been tested for backwards compatibility

Closes #79

Post-script verification

  • Branch is not main/master (agent/79-add-claude-md)
  • Secret scan passed (gitleaks — cb5be8743bd472e9fa9b5d540c1f386e0e1cc474..HEAD)
  • PR body secret scan passed (gitleaks — no-git)

Add CLAUDE.md to provide AI agents with repo-specific context,
eliminating the zero-context problem observed in PRs #77 and #78.

The file covers:
- Project overview (Red Hat downstream Helm rebuild)
- Build commands (make build/test/build-cross)
- FIPS build flags on release branches (GOFIPS140, godebug)
- Test commands and patterns (testify, golden files)
- Dependency management (go modules, vendoring on release branches)
- Branch strategy (main for v4, release-X.Y for Red Hat rebuilds)
- Downstream integration (Jira HELM-xxx/OCPTOOLS-xxx, OCP targets,
  upstream_sources.yml, Brew builds)
- Review guidance for dependency bumps

The file is 92 lines, focused on what agents need to make good
decisions without trial-and-error exploration.

Closes #79
@fullsend-ai-coder fullsend-ai-coder Bot added the ready-for-review Triggers review agent dispatch label Sep 28, 2026
@openshift-ci
openshift-ci Bot requested review from baijum and martinszuc September 28, 2026 06:59
@openshift-ci

openshift-ci Bot commented Sep 28, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: fullsend-ai-coder[bot]
Once this PR has been reviewed and has the lgtm label, please assign sowmya-sl for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci

openshift-ci Bot commented Sep 28, 2026

Copy link
Copy Markdown

Hi @fullsend-ai-coder[bot]. Thanks for your PR.

I'm waiting for a redhat-developer member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@fullsend-ai-review

fullsend-ai-review Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 7:00 AM UTC · Completed 7:15 AM UTC

Commit: 7a40b7d · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $3.59

@fullsend-ai-review fullsend-ai-review Bot added the risk/low PR risk: low label Sep 28, 2026
@fullsend-ai-review

Copy link
Copy Markdown

Risk Assessment: low (1/5)

Details

Bot-authored docs-only PR adding a single new CLAUDE.md file (92 lines) that directly satisfies a scoped issue; PROTECTED_PATH_COUNT=1 is the sole elevated signal, but all size, security, CI, dependency, and history dimensions are at minimum, yielding a composite of ~1.2 which rounds to 1.

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Medium

  • [protected-path] CLAUDE.md — This PR adds CLAUDE.md, which is a protected governance path. The PR is linked to Issue Add CLAUDE.md to provide agents with repo-specific context #79 and provides clear justification for the addition. Human approval is required for all protected-path changes regardless of context.

Low

  • [internal consistency] CLAUDE.md:63 — The branch strategy table lists only main and release-X.Y, but dev-v3 is described in prose at line 69. CI configurations confirm dev-v3 is a first-class branch (referenced in build-test.yml, codeql-analysis.yml, and dependabot.yml). An agent scanning the table as a quick reference would miss this branch.

  • [scope-creep] CLAUDE.md:69 — Lines 69–70 introduce the dev-v3 branch, which was not listed in Issue Add CLAUDE.md to provide agents with repo-specific context #79's branch strategy requirements. The addition is factually accurate and useful for agents, but extends slightly beyond the explicit scope of the issue.

@fullsend-ai-review fullsend-ai-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the review comment for full details.

Comment thread CLAUDE.md
| Branch | Purpose |
|--------|---------|
| `main` | Default branch. Helm v4 development (unstable) |
| `release-X.Y` | Track upstream Helm releases for Red Hat rebuilds |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] internal consistency

The branch strategy table lists only main and release-X.Y, but dev-v3 is described in prose at line 69. CI configurations confirm dev-v3 is a first-class branch (build-test.yml, codeql-analysis.yml, dependabot.yml). An agent scanning the table as a quick reference would miss this branch.

Comment thread CLAUDE.md
a PR, check the issue for the target branch — it may specify a release
branch (e.g. "apply to release-3.21").

Helm v3 stable development continues on `dev-v3`. Bug fixes go to v4

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] scope-creep

Lines 69-70 introduce the dev-v3 branch, which was not listed in Issue #79's branch strategy requirements. The addition is factually accurate and useful for agents, but extends slightly beyond the explicit scope of the issue.

@fullsend-ai-review fullsend-ai-review Bot added the requires-manual-review Review requires human judgment label Sep 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-ok-to-test ready-for-review Triggers review agent dispatch requires-manual-review Review requires human judgment risk/low PR risk: low

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CLAUDE.md to provide agents with repo-specific context

0 participants